home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / zwordz11.zip / WORDZ.DOC < prev    next >
Text File  |  1993-04-03  |  14KB  |  333 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                 Corporate Headquarters BBS (815) 886-3233                   ║
  4. ║                                            (815) 886-9381                   ║
  5. ║                                                                             ║
  6. ║                               Z  - W O R D Z                                ║
  7. ║                                    v1.1                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║       Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire, WWIV,        ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1993                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20.  
  21. Z-Wordz is released as SHAREWARE. You are granted a limited license to
  22. evaluate the program. Try it out, if you continue to use it you are required
  23. to register the program.
  24.  
  25. Z-Wordz was previously released as Word-Z. Another program, totally
  26. unrelated had the name Wordz. The author of Wordz thought Word-Z was to
  27. similar and demanded a name change. So be it, Z-Wordz is the new name.
  28.  
  29. To register the program send $15.00 along with your name and BBS phone # to:
  30. Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441. See the file MAILER.TXT
  31. for additonal pricing information and special discounts available. You
  32. may also register ONLINE with Visa, MasterCard, American Express or
  33. Discover by calling the support BBS at (815) 886-3233 or (815) 886-9381.
  34. Simply type CHARGE at the main menu.
  35.  
  36. Once you register Z-Wordz, you will be given your own unique registration
  37. number that will inform Z-Wordz that the program is registered. The BBS name
  38. supplied with payment will be the name used to create your unique
  39. registration number.
  40.  
  41. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  42. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  43. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  44. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  45. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  46. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  47.  
  48.  
  49. Z-Wordz is a online game, based somewhat on the board game CrossWords.
  50. It's easy to play, making it great for all ages (my 7 year old son
  51. finds it fun to play - and it stimulates his vocabulary), but it's also
  52. challenging to keep players busy trying over and over to improve their
  53. Z-Wordz average.
  54.  
  55. Z-Wordz is a game where the player tries to complete the Z-WORDZ (you'll
  56. understand when you see the game) by completing three words all linked
  57. together forming the Z-WORDZ (believe me, you'll understand when you see
  58. the game) from a random selection of letters. In each round the player
  59. is displayed a letter, this letter may be placed in the Z-WORDZ or
  60. discarded. Players are limited to only 10 discards per round. Once the
  61. Z-WORDZ are filled, Z-Wordz checks the words created against it's own
  62. dictionary. Z-Wordz awards points for each correct word based on a set
  63. value for each letter. Invalid words are ignored. Refer to the WORDZ.HLP
  64. file for additional playing information.
  65.  
  66. As distributed, Z-Wordz has a dictionary file of over 950 three letter
  67. words. Feel free to add your own to the WORDZ.DIC file using your 
  68. favorite text editor. Don't worry about making sure the list is sorted
  69. as Z-Wordz doesn't require a sorted listing. You may make the WORDZ.DIC
  70. file almost as large as you'd like, a test file of 3200 words was used
  71. to test Z-Wordz. The routine used to validate words is so fast that even
  72. with 3200 words, Z-Wordz was able to validate all three words almost
  73. instantaneously.
  74.  
  75. Z-Wordz keeps track of dual scoreboards, one ranking each player on their
  76. overall monthly average per round and a second ranking the top 10 Z-Wordz
  77. scores for the month. Z-Wordz will automatically reset the scoreboard at
  78. the start of each month, requiring no sysop maintenance after initial
  79. set-up.
  80.  
  81.  
  82. FEATURES OF Z-Wordz:
  83.  
  84.   -  Easy to install and requires no maintenance.
  85.  
  86.   -  Ansi colors and display.
  87.  
  88.   -  Terminates cleanly through exit code even on runtime error.
  89.  
  90.   -  Automatically creates a top score listing suitable for inclusion
  91.      as a text/bulletin file for display within your BBS. Both an
  92.      ANSI and ASCII file is created.
  93.  
  94.   -  Detects loss of carrier.
  95.  
  96.   -  Operates in local mode (either direct from BBS or from command line).
  97.  
  98.   -  Sysop function keys to return to the board, chat mode, user stats,
  99.      increase/decrease time, etc.
  100.  
  101.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, WWIV,
  102.      Ultra BBS, Telegard, TriTel and Remote Access.
  103.  
  104.   -  Support for baud rates up to 115,200
  105.  
  106.   -  Support for COM1-15. Optional command line for non-standard IRQ's.
  107.  
  108.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  109.  
  110.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  111.      program.
  112.  
  113.   -  Fully Multi-Node compatible.
  114.  
  115.  
  116.  
  117. FIRST TIME OPERATIONS
  118.  
  119. Simply create a directory for Z-Wordz and copy all files distributed
  120. with Z-Wordz to this directory. Additional data files will automatically
  121. be created the first time Z-Wordz is run.
  122.  
  123.  
  124. CONFIGURING THE PROGRAM
  125. Using your favorite text editor, edit the file WORDZ.CFG. Below is the
  126. layout of this file:
  127.  
  128. C:\PCB\PCBOARD.SYS
  129. Corporate Headquarters
  130. Bob
  131. Neal
  132. 15
  133. 0
  134. 5
  135.  
  136. Line 1 = Full pathname of your door file. Formats supported by this
  137.          program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  138.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  139.                       CHAIN.TXT, GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS.
  140.                       When using USERINFO.DAT, DOOR.SYS  must be in
  141.                       the same directory as USERINFO.DAT.
  142. Line 2 = BBS name
  143. Line 3 = Sysop First Name
  144. Line 4 = Sysop Last Name
  145. Line 5 = number of rounds per day that a player may play. I suggest
  146.                a daily limit of 10 to 20, but tailor to your own needs.
  147. Line 6 = Registration number. Leave as 0 if unregistered.
  148. Line 7 = Number of plays required before user is listed in the TOP 10
  149.                scoreboard. Set to 0 if you want to disable this option.
  150.  
  151.  
  152. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  153. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  154. including the following either in your BBS batch or AUTOEXEC.BAT file:
  155.  
  156.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  157.     SET PCBDIR=\BBS            <- Path of your BBS files
  158.  
  159. Then, in your WORDZ.CFG file, on the first line you may put:
  160.  
  161.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  162.  
  163. This allows you to use just one .CFG file for multi-node operation.
  164.  
  165.  
  166.  
  167. EXECUTING PROGRAM
  168.  
  169. To execute the program, enter the filename followed by the config file
  170. name (ie ZWORDZ ZWORDZ.CFG). If you are running the program from the
  171. command line, you may optionally enter ZWORDZ LOCAL. The only problem
  172. with this is the default user name sysop is used instead of the name on
  173. your board. This is good for testing the game before putting it on your
  174. system, but you should once play begins, execute the program locally
  175. from your BBS or consistantly run the game from the command line when
  176. you play.
  177.  
  178. You may also specify a non-standard IRQ. Put the IRQ number after the
  179. .CFG on the command line. For example: ZWORDZ ZWORDZ.CFG /5. This
  180. example tells the program to use IRQ 5 instead of the standard IRQ.
  181.  
  182. You may also use the procedure above and create a variable IRQ so that
  183. you can pass the IRQ setting as: ZWORDZ ZWORDZ.CFG /%IRQ%
  184.  
  185. Some users may have had conflicts when using non-standard IRQ's on
  186. Novell/Netware systems. Novell seems to use the "/" character for
  187. parameter passing. You may not optionally use the "*" character instead
  188. of the "/", for example ZWORDZ ZWORDZ.CFG *%IRQ% is valid. Both "*" and
  189. "/" will work.
  190.  
  191.  
  192. AUTOMATIC MAINTENANCE
  193.  
  194. The program will automatically during the first play of each new month
  195. reset it's user file and top score listing. The previous months scoreboard
  196. will automatically be renamed to WORDZ.OLD and WORDZG.OLD.  This can then
  197. be included as a text file to display the previous months winners.
  198.  
  199. You should be aware of this so if you are starting a new game for the
  200. first time towards the end of the month, the game will automatically perform
  201. the maintenace come the first of the month.
  202.  
  203. As an option, you may pass the parameter "NEW" on the command line, for 
  204. example ZWORDZ NEW. This will reset _all_ Z-Wordz data files, including the
  205. overall high scorer information. 
  206.  
  207.  
  208.  
  209. FOSSIL DRIVER
  210.  
  211. Z-Wordz now includes support for FOSSIL drivers. This means that the
  212. program will now work with Digiboard (for Wildcat M and PCBoard/M
  213. versions) and other multi-port boards. To activate the Fossil driver
  214. support just include /FD on the command line in your door batch file.
  215.  
  216.         For example: ZWORDZ ZWORDZ.CFG /FD
  217.  
  218. If no Fossil driver is available, Z-Wordz will display a message
  219. indicating such and exit cleanly.
  220.  
  221.  
  222.  
  223. This documentation will not go into the mechanics of how you set-up a door
  224. program on your BBS. It is assumed that you have a working knowledge of
  225. how to complete this task.
  226.  
  227.  
  228. SYSOP KEYS ACTIVE
  229.  
  230. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  231.          written to DOOR.SYS and USERS.SYS
  232. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  233.          and/or written to DOOR.SYS and USERS.SYS
  234. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  235. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  236.          and/or written to DOOR.SYS and USERS.SYS
  237. F8    -  Returns the caller involuntarily to the BBS.
  238. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  239.          and/or written to DOOR.SYS and USERS.SYS
  240. F10   -  Activates SysOp CHAT mode within the DOOR.
  241. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  242. UP    -  Give the caller extra time while in the DOOR.  
  243. DN    -  Subtract time from the caller while in the DOOR. 
  244. HOME  -  HELP key for Status Line options.
  245. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  246. ALT-X -  PCBoard will exit after current caller logs off. Value is
  247.          passed to PCBoard. Not available on non-PCBoard systems.
  248.  
  249.  
  250.  
  251.  
  252. FILES USED AND CREATED
  253.  
  254. ZWORDZ.EXE - The program itself
  255. ZWORDZ.DOC - Documentation for the sysop to run Z-Wordz
  256. WORDZ.DIC - Dictionary file
  257. ZWORDZ.CFG - Configuration file
  258.  
  259.  
  260. The following files will be created by Z-Wordz
  261.  
  262. WORDZ.USR  - User file of current players
  263. WORDZ      - Top 10 scores in ascii format can be used as a bulletin
  264. WORDZG     - Top 10 scores in ANSI format
  265. WORDZ.OLD  - Previous month top 10 ascii bulletin
  266. WORDZG.OLD - Previous month top 10 ANSI bulletin
  267. WORDZ.DAT  - Contains information for scoreboard
  268. WORDZ.HI   - Contains overall high score information
  269. WORDZ.AVG  - Data file for scoreboard
  270. WORDZ.TOT  - Data file for scoreboard
  271.  
  272.  
  273. CONTACT ME FOR SUPPORT
  274.  
  275. If you encounter any problems you may contact me at Corporate Headquarters
  276. BBS (815) 886-3233 or (815) 886-9381.
  277.  
  278. I can also be reached via the RIME network in the SYSOP, DOORS,
  279. SHAREWARE and BBS SOFTWARE conferences as well as the COMMON conference.
  280.  
  281. If you have any suggestions for improvements for this program, please feel
  282. free to let me know. This game has included suggestions from users of my
  283. BBS during beta testing.
  284.  
  285.  
  286.  
  287. VERSION HISTORY
  288.  
  289. v1.1 - (04/03/93)
  290.         First, a new name. Previously named WORD-Z, now called Z-WORDZ.
  291.         Users upgrading from v1.0 will need to rename their WORDZ.CFG
  292.         file to ZWORDZ.CFG and update their door file batch and menu
  293.         files. All data filename for Z-Wordz has been kept the same
  294.         from Word-Z.
  295.  
  296.         Revised the routine that randomly selected letters, a vowel now
  297.         has a better chance of being selected.
  298.  
  299.         Expanded and refined the dictionary file. Now over 950 words and
  300.         based on the words found in the Official Scrabble Players
  301.         Dictionary.
  302.  
  303.         Added option to require a minimum number of plays before a
  304.         players score is shown in the top 10 scoreboard. This prevents a
  305.         user from playing 1 time and getting a high score that is
  306.         impossible to be with repeated plays.
  307.  
  308.         Fixed a bug where a player was allowed to play one more time
  309.         than the sysop had configured.
  310.  
  311.         Fixed a problem with the file I/O. Did not have all file access
  312.         opened for SHARED I/O. Users with a multi-node system may find
  313.         that a user was suddenly kicked out of the game. Now fixed, all
  314.         file read/writes are done under a SHARED access.
  315.  
  316.  
  317.  
  318.  
  319. v1.0 - (03/05/93)
  320.     Initial Release
  321.  
  322.  
  323. DISTRIBUTION SITES:
  324.  
  325.    As always you can find the latest version of Z-Wordz available for
  326.    downloading from Corporate Headquarters BBS.
  327.  
  328.    Calls for support for Z-Wordz should be directed only to
  329.    Corporate Headquarters BBS.
  330.  
  331.    Corporate Headquarters BBS   (815) 886-3233  (14400 v.32bis)
  332.                                       886-9381  (14400 v.32bis)
  333.